home *** CD-ROM | disk | FTP | other *** search
/ IBM InfoROM for OS/2 Beta 1995 January / IBM InfoROM for OS2 Beta 1-1995.ISO / testcert / storage / function / scsi / ioctl / scsi.gra < prev    next >
Encoding:
Text File  |  1994-08-02  |  10.6 KB  |  251 lines
  1. ******************************************************************************
  2. **                       SCSI.GRA Description File                          **
  3. ******************************************************************************
  4. **                          SCSI FUNCTION CALLS                             **
  5. ******************************************************************************
  6. @IMPORT GLOBAL.GRA
  7.  
  8. ******************************************************************************
  9. ** THIS FUNCTION OPENS THE SCSI ADAPTER DEVICE DRIVER
  10. **
  11. **   REQUIRED INPUT PARAMETERS:  NONE
  12. **
  13. **   OUTPUT PARAMETERS:          DRIVEHANDLE  ( SETS )
  14. **
  15. **   LOGGED DATA:                NONE
  16. **
  17. SCSI_OPEN                      $DLL=DDTSCSI    \
  18.                                $FUNC=_SCSI_Open 
  19.  
  20. ******************************************************************************
  21. ** THIS FUNCTION CLOSES THE SCSI ADAPTER DEVICE DRIVER
  22. **
  23. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  24. **
  25. **   OUTPUT PARAMETERS:          NONE
  26. **
  27. **   LOGGED DATA:                NONE
  28. **
  29. SCSI_CLOSE                     $DLL=DDTSCSI    \
  30.                                DRIVEHANDLE=NUM \
  31.                                $FUNC=_SCSI_Close 
  32.  
  33. ******************************************************************************
  34. ** THIS FUNCTION QUERIES THE SCSI CARD AND RETURNS SOME INFORMATION ABOUT THE
  35. ** SCSI CARD
  36. **
  37. **   NEEDED PARAMETERS:          DRIVEHANDLE   ( SET BY SCSI_OPEN )
  38. **                               DEVICEHANDLE - OBTAINED BY CALLING 
  39. **                                              SCSI_ALLOCATEDEVICE
  40. **
  41. **   OUTPUT PARAMETERS:          NONE
  42. **
  43. **   LOGGED DATA:                DEVICE KEY INDEX
  44. **                               SCB ARCHITECTURE CARD COMP. LEVEL
  45. **                               ADAPTER INDEX
  46. **                               DEVICE FLAGS
  47. **                               LOGICAL UNIT NUMBER (LUN)
  48. **                               PHYSICAL UNIT NUMBER (PUN)
  49. **
  50. SCSI_PARAMS                     $DLL=DDTSCSI        \
  51.                                 DRIVEHANDLE=NUM     \
  52.                                 DEVICEHANDLE=NUM    \
  53.                                 $FUNC=_SCSI_ReadDevParams 
  54.  
  55. ******************************************************************************
  56. ** THIS FUNCTION ISSUES A COMMAND TO RESET THE PHYSICAL DEVICE
  57. **
  58. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  59. **                               DEVICEHANDLE - OBTAINED BY CALLING
  60. **                                              SCSI_ALLOCATEDEVICE
  61. **
  62. **   OUTPUT PARAMETERS:          NONE
  63. **
  64. **   LOGGED DATA:                NONE
  65. **
  66. SCSI_RESETINIT                  $DLL=DDTSCSI    \
  67.                                 DRIVEHANDLE=NUM         \
  68.                                 DEVICEHANDLE=NUM        \
  69.                                 $FUNC=_SCSI_ResetInitialize 
  70.  
  71. ******************************************************************************
  72. ** THIS FUNCTION ENABLES THE ADAPTER CACHE CAPABILITY FOR ALL SUBSEQUENT
  73. ** COMMANDS TO THE SCSI DEVICE.
  74. **
  75. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  76. **                               DEVICEHANDLE - OBTAINED BY CALLING
  77. **                                              SCSI_ALLOCATEDEVICE
  78. **
  79. **   OUTPUT PARAMETERS:          NONE
  80. **
  81. **   LOGGED DATA:                NONE
  82. **
  83. SCSI_ENABLECACHE                $DLL=DDTSCSI    \
  84.                                 DRIVEHANDLE=NUM         \
  85.                                 DEVICEHANDLE=NUM        \
  86.                                 $FUNC=_SCSI_EnableAdapterCache 
  87.  
  88. ******************************************************************************
  89. ** THIS FUNCTION DISABLES THE ADAPTER CACHE CAPABILITY FOR ALL SUBSEQUENT
  90. ** COMMANDS TO THE SCSI DEVICE.
  91. **
  92. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  93. **                               DEVICEHANDLE - OBTAINED BY CALLING
  94. **                                              SCSI_ALLOCATEDEVICE
  95. **
  96. **   OUTPUT PARAMETERS:          NONE
  97. **
  98. **   LOGGED DATA:                NONE
  99. **
  100. SCSI_DISABLECACHE               $DLL=DDTSCSI    \
  101.                                 DRIVEHANDLE=NUM         \
  102.                                 DEVICEHANDLE=NUM        \
  103.                                 $FUNC=_SCSI_DisableAdapterCache 
  104.  
  105. ******************************************************************************
  106. ** THIS FUNCTION RETURNS THE ADAPTER CACHE STATUS FOR THE SPECIFIED
  107. ** SCSI DEVICE.
  108. **
  109. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  110. **                               DEVICEHANDLE - OBTAINED BY CALLING
  111. **                                              SCSI_ALLOCATEDEVICE
  112. **
  113. **   OUTPUT PARAMETERS:          NONE
  114. **
  115. **   LOGGED DATA:                ADAPTER CACHE STATUS
  116. **
  117. SCSI_CACHESTATUS                $DLL=DDTSCSI    \
  118.                                 DRIVEHANDLE=NUM         \
  119.                                 DEVICEHANDLE=NUM        \
  120.                                 $FUNC=_SCSI_AdaptCacheStatus 
  121.  
  122. ******************************************************************************
  123. ** THIS FUNCTION SETS THE TIMEOUT VALUE FOR THE DEVICE
  124. **
  125. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  126. **                               DEVICEHANDLE - OBTAINED BY CALLING
  127. **                                              SCSI_ALLOCATEDEVICE
  128. **                               TIMEOUT 
  129. **
  130. **   OUTPUT PARAMETERS:          NONE
  131. **
  132. **   LOGGED DATA:                NONE
  133. **
  134. SCSI_SETDEVTIMEOUT              $DLL=DDTSCSI    \
  135.                                 DRIVEHANDLE=NUM         \
  136.                                 DEVICEHANDLE=NUM        \
  137.                                 TIMEOUT=NUM             \
  138.                                 $FUNC=_SCSI_SetDeviceTimeout 
  139.  
  140. ******************************************************************************
  141. ** THIS FUNCTION RETURNS THE CURRENT TIMEOUT VALUE FOR THE DEVICE
  142. **
  143. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  144. **                               DEVICEHANDLE - OBTAINED BY CALLING
  145. **                                              SCSI_ALLOCATEDEVICE
  146. **
  147. **   OUTPUT PARAMETERS:          NONE
  148. **
  149. **   LOGGED DATA:                TIMEOUT
  150. **
  151. SCSI_READDEVTIMEOUT             $DLL=DDTSCSI    \
  152.                                 DRIVEHANDLE=NUM         \
  153.                                 DEVICEHANDLE=NUM        \
  154.                                 $FUNC=_SCSI_ReadDeviceTimeout 
  155.  
  156. ******************************************************************************
  157. ** THIS FUNCTION CAUSES AN SCB OR A CHAIN OF SCB'S TO BE SENT TO THE
  158. ** ADAPTER
  159. **
  160. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  161. **                               DEVICEHANDLE - OBTAINED BY CALLING
  162. **                                              SCSI_ALLOCATEDEVICE
  163. **                               PHYSICALSCBPTR  - PHYSICAL POINTER TO SCB
  164. **                               LOGICALSCBPTR   - LOGICAL POINTER TO SCB CHAIN HEADER
  165. **                               FLAGS
  166. **
  167. **   OUTPUT PARAMETERS:          NONE
  168. **
  169. **   LOGGED DATA:                NONE
  170. **
  171. SCSI_TRANSFERSCB                $DLL=DDTSCSI    \
  172.                                 DRIVEHANDLE=NUM         \
  173.                                 DEVICEHANDLE=NUM        \
  174.                                 PHYSICALSCBPTR=NUM      \
  175.                                 LOGICALSCBPTR=NUM       \
  176.                                 FLAGS=NUM               \
  177.                                 $FUNC=_SCSI_TransferSCB 
  178.  
  179. ******************************************************************************
  180. ** THIS FUNCTION ALLOCATES A SCSI PERIPHERAL DEVICE AND RETURNS THE 
  181. ** DEVICE HANDLE THAT WILL BE USED TO ACCESS THE DEVICE
  182. **
  183. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  184. **                               PERIPHTYPE  -  DEVICE PERIPHERAL TYPE
  185. **                               DEVTYPEFLG  -  DEVICE TYPE FLAGS
  186. **                               AVAILDEV    -  Nth AVAILABLE
  187. **
  188. **   OUTPUT PARAMETERS:          NONE
  189. **
  190. **   LOGGED DATA:                DEVICEHANDLE
  191. **
  192. SCSI_ALLOCATEDEVICE             $DLL=DDTSCSI    \
  193.                                 DRIVEHANDLE=NUM        \
  194.                                 PERIPHTYPE=NUM          \
  195.                                 DEVTYPEFLG=NUM          \
  196.                                 AVAILDEV=NUM            \
  197.                                 $FUNC=_SCSI_AllocateDevice 
  198.  
  199. ******************************************************************************
  200. ** THIS FUNCTION DEALLOCATES THE SCSI PERIPHERAL DEVICE ASSIGNED TO THIS
  201. ** DEVICE HANDLE
  202. **
  203. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  204. **                               DEVICEHANDLE - OBTAINED BY CALLING
  205. **                                              SCSI_ALLOCATEDEVICE
  206. **
  207. **   OUTPUT PARAMETERS:          NONE
  208. **
  209. **   LOGGED DATA:                NONE
  210. **
  211. SCSI_DEALLOCATEDEVICE           $DLL=DDTSCSI    \
  212.                                 DRIVEHANDLE=NUM         \
  213.                                 DEVICEHANDLE=NUM        \
  214.                                 $FUNC=_SCSI_DeallocateDevice 
  215.  
  216. ******************************************************************************
  217. ** THIS FUNCTION RETURNS A COUNT OF THE NUMBER OF DEVICES OF A PARTICULAR
  218. ** TYPE THAT ARE DETECTED
  219. **
  220. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  221. **                               PERIPHTYPE  - DEVICE PERIPHERAL TYPE
  222. **                               DEVTYPEFLG  - DEVICE TYPE FLAGS
  223. **
  224. **   OUTPUT PARAMETERS:          NONE
  225. **
  226. **   LOGGED DATA:                COUNT OF DEVICE TYPE REQUESTED
  227. **
  228. SCSI_PERIPHERALTYPECOUNT        $DLL=DDTSCSI    \
  229.                                 DRIVEHANDLE=NUM         \
  230.                                 PERIPHTYPE=NUM          \
  231.                                 DEVTYPEFLG=ALNUM          \
  232.                                 $FUNC=_SCSI_PeripheralTypeCount 
  233.  
  234. ******************************************************************************
  235. ** THIS FUNCTION CAUSES AN ABORT REQUEST TO BE SENT TO THE DEVICE
  236. **
  237. **   REQUIRED INPUT PARAMETERS:  DRIVEHANDLE   ( SET BY SCSI_OPEN )
  238. **                               DEVICEHANDLE - OBTAINED BY CALLING
  239. **                                              SCSI_ALLOCATEDEVICE
  240. **
  241. **   OUTPUT PARAMETERS:          NONE
  242. **
  243. **   LOGGED DATA:                NONE
  244. **
  245. SCSI_SENDABORT                  $DLL=DDTSCSI    \
  246.                                 DRIVEHANDLE=NUM         \
  247.                                 DEVICEHANDLE=NUM        \
  248.                                 $FUNC=_SCSI_SendAbort 
  249.  
  250. ******************************************************************************
  251.